<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../print.css" type="text/css" media="print">
<meta content="Log,mx.logging.Log,addTarget,flush,getLogger,hasIllegalCharacters,isDebug,isError,isFatal,isInfo,isWarn,removeTarget" name="keywords">
<title>mx.logging.Log</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'Log - Zentrum virtUOS: virtPresenter';
				var baseRef = '../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">virtPresenter AsDoc</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../all-classes.html')" href="../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../all-classes.html')" href="../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../index-list.html')" href="../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../index.html?mx/logging/Log.html&amp;mx/logging/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;Log</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class Log"); titleBar_setSubNav(false,false,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">mx.logging</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class Log</td>
</tr>
</table>
<p></p>
  Provides pseudo-hierarchical logging capabilities with multiple format and
  output options.
  The log system consists of two major components, the logger and a target.
  You can use the logger to send information to a target.
  The target is responsible for formatting and general output of the log data.
  <p>
  Loggers are singleton instances created for a particular category of
  information.
  Typically, the category is the package name of the component
  that desires to log information.
  The category provides users the ability to specify what log information they
  are interested in.
  Multiple categories can be selected and combined with regular expressions.
  This allows for both broad and narrow logging information to be acquired.
  For example, you might be interested in all logging information under
  the "mx.messaging" and "mx.rpc" packages and want the output from these
  packages to be formatted as XML.
  To get the all of the logging information under the "mx.messaging" category
  including sub-packages and components a wildcard expression is required, such as
  "mx.messaging.*".
  See the code example below for more details.
  </p>
  <p>Targets provide the output mechanism of the data being logged.
  This mechanism typically includes formatting, transmission, or storage, but
  can be anything possible under the VM.
  There are two targets provided: <code>MiniDebugTarget</code> and 
  <code>TraceTarget</code>.
  Each of these writers take the current log information and "sends" it
  somewhere for display and/or storage.
  Targets also provide the specification of what log data to output.
  </p>
   <p></p>
<br>
<span class="label">Example</span>
<br>  <pre>
  ... 
  import mx.logging.targets.
  import mx.logging.
   private function initLogging():void {
      // Create a target.
      var logTarget:TraceTarget = new TraceTarget();
       // Log only messages for the classes in the mx.rpc.and 
      // mx.messaging packages.
      logTarget.filters=["mx.rpc.,"mx.messaging.];
       // Log all log levels.
      logTarget.level = LogEventLevel.ALL;
       // Add date, time, category, and log level to the output.
      logTarget.includeDate = true;
      logTarget.includeTime = true;
      logTarget.includeCategory = true;
      logTarget.includeLevel = true;
       // Begin logging.
      Log.addTarget(logTarget);
  } 
  ...
  </pre>
 <p></p>
<br>
<hr>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#addTarget()">addTarget</a>(target:<a href="ILoggingTarget.html">ILoggingTarget</a>):void</div>
<div class="summaryTableDescription">[static]
      Allows the specified target to begin receiving notification of log
      events.</div>
</td><td class="summaryTableOwnerCol">Log</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#flush()">flush</a>():void</div>
<div class="summaryTableDescription">[static]
      This method removes all of the current loggers from the cache.</div>
</td><td class="summaryTableOwnerCol">Log</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getLogger()">getLogger</a>(category:String):<a href="../logging/ILogger.html">ILogger</a>
</div>
<div class="summaryTableDescription">[static]
      Returns the logger associated with the specified category.</div>
</td><td class="summaryTableOwnerCol">Log</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#hasIllegalCharacters()">hasIllegalCharacters</a>(value:String):Boolean</div>
<div class="summaryTableDescription">[static]
      This method checks the specified string value for illegal characters.</div>
</td><td class="summaryTableOwnerCol">Log</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#isDebug()">isDebug</a>():Boolean</div>
<div class="summaryTableDescription">[static]
      Indicates whether a debug level log event will be processed by a
      log target.</div>
</td><td class="summaryTableOwnerCol">Log</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#isError()">isError</a>():Boolean</div>
<div class="summaryTableDescription">[static]
      Indicates whether an error level log event will be processed by a
      log target.</div>
</td><td class="summaryTableOwnerCol">Log</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#isFatal()">isFatal</a>():Boolean</div>
<div class="summaryTableDescription">[static]
      Indicates whether a fatal level log event will be processed by a
      log target.</div>
</td><td class="summaryTableOwnerCol">Log</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#isInfo()">isInfo</a>():Boolean</div>
<div class="summaryTableDescription">[static]
      Indicates whether an info level log event will be processed by a
      log target.</div>
</td><td class="summaryTableOwnerCol">Log</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#isWarn()">isWarn</a>():Boolean</div>
<div class="summaryTableDescription">[static]
      Indicates whether a warn level log event will be processed by a
      log target.</div>
</td><td class="summaryTableOwnerCol">Log</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#removeTarget()">removeTarget</a>(target:<a href="ILoggingTarget.html">ILoggingTarget</a>):void</div>
<div class="summaryTableDescription">[static]
      Stops the specified target from receiving notification of log
      events.</div>
</td><td class="summaryTableOwnerCol">Log</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="addTarget()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">addTarget</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public static function addTarget(target:<a href="ILoggingTarget.html">ILoggingTarget</a>):void</code><p>
      Allows the specified target to begin receiving notification of log
      events.
           </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">target</span>:<a href="ILoggingTarget.html">ILoggingTarget</a></code> &mdash; specific target that should capture log events.
     </td>
</tr>
</table>
</div>
<a name="flush()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">flush</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function flush():void</code><p>
      This method removes all of the current loggers from the cache.
      Subsquent calls to the <code>getLogger()</code> method return new instances
      of loggers rather than any previous instances with the same category.
      This method is intended for use in debugging only.
     </p></div>
<a name="getLogger()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getLogger</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function getLogger(category:String):<a href="../logging/ILogger.html">ILogger</a></code><p>
      Returns the logger associated with the specified category.
      If the category given doesn't exist a new instance of a logger will be
      returned and associated with that category.
      Categories must be at least one character in length and may not contain
      any blanks or any of the following characters:
      []~$^&amp;\/(){}&lt;&gt;+=`!#%?,:;'"&#64;
      This method will throw an <code>InvalidCategoryError</code> if the
      category specified is malformed.
           </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">category</span>:String</code> &mdash; The category of the logger that should be returned.
           </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../logging/ILogger.html">ILogger</a></code> &mdash; 
                        An instance of a logger object for the specified name.
      If the name doesn't exist, a new instance with the specified
      name is returned.
     
                        
                     </td>
</tr>
</table>
</div>
<a name="hasIllegalCharacters()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">hasIllegalCharacters</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function hasIllegalCharacters(value:String):Boolean</code><p>
      This method checks the specified string value for illegal characters.
           </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">value</span>:String</code> &mdash; The String to check for illegal characters.
                The following characters are not valid:
                    []~$^&amp;\/(){}&lt;&gt;+=`!#%?,:;'"&#64;
      </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Boolean</code> &mdash;   <code>true</code> if there are any illegal characters found,
                <code>false</code> otherwise
     </td>
</tr>
</table>
</div>
<a name="isDebug()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">isDebug</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function isDebug():Boolean</code><p>
      Indicates whether a debug level log event will be processed by a
      log target.
           </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Boolean</code> &mdash; true if a debug level log event will be logged; otherwise false.
     </td>
</tr>
</table>
</div>
<a name="isError()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">isError</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function isError():Boolean</code><p>
      Indicates whether an error level log event will be processed by a
      log target.
           </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Boolean</code> &mdash; true if an error level log event will be logged; otherwise false.
     </td>
</tr>
</table>
</div>
<a name="isFatal()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">isFatal</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function isFatal():Boolean</code><p>
      Indicates whether a fatal level log event will be processed by a
      log target.
           </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Boolean</code> &mdash; true if a fatal level log event will be logged; otherwise false.
     </td>
</tr>
</table>
</div>
<a name="isInfo()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">isInfo</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function isInfo():Boolean</code><p>
      Indicates whether an info level log event will be processed by a
      log target.
           </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Boolean</code> &mdash; true if an info level log event will be logged; otherwise false.
     </td>
</tr>
</table>
</div>
<a name="isWarn()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">isWarn</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function isWarn():Boolean</code><p>
      Indicates whether a warn level log event will be processed by a
      log target.
           </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Boolean</code> &mdash; true if a warn level log event will be logged; otherwise false.
     </td>
</tr>
</table>
</div>
<a name="removeTarget()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">removeTarget</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function removeTarget(target:<a href="ILoggingTarget.html">ILoggingTarget</a>):void</code><p>
      Stops the specified target from receiving notification of log
      events.
           </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">target</span>:<a href="ILoggingTarget.html">ILoggingTarget</a></code> &mdash; specific target that should capture log events.
     </td>
</tr>
</table>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
